<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>wickr-crypto-c: wickr_stream_key Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">wickr-crypto-c
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">wickr_stream_key Struct Reference<div class="ingroups"><a class="el" href="group__wickr__stream__key.html">wickr_stream_key</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>A data structure representing the stream encoding / decoding key material A stream key holds information about the key material used for cipher operations as well as it's next evolution key and the number of packets this key should be used to encode or decode before evolution takes place.  
 <a href="structwickr__stream__key.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="stream__key_8h_source.html">stream_key.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a3d957a51193dda882cb89ced2ceeb91e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structwickr__cipher__key.html">wickr_cipher_key_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwickr__stream__key.html#a3d957a51193dda882cb89ced2ceeb91e">cipher_key</a></td></tr>
<tr class="separator:a3d957a51193dda882cb89ced2ceeb91e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7210bd67e61cb4c38733a237dae95d9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structwickr__buffer.html">wickr_buffer_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwickr__stream__key.html#ae7210bd67e61cb4c38733a237dae95d9">evolution_key</a></td></tr>
<tr class="separator:ae7210bd67e61cb4c38733a237dae95d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51e59da9f7fbb0b3e1332a20252d1cc6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structwickr__buffer.html">wickr_buffer_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwickr__stream__key.html#a51e59da9f7fbb0b3e1332a20252d1cc6">user_data</a></td></tr>
<tr class="separator:a51e59da9f7fbb0b3e1332a20252d1cc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78777e4c64048b6dae38f8772744194e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwickr__stream__key.html#a78777e4c64048b6dae38f8772744194e">packets_per_evolution</a></td></tr>
<tr class="separator:a78777e4c64048b6dae38f8772744194e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A data structure representing the stream encoding / decoding key material A stream key holds information about the key material used for cipher operations as well as it's next evolution key and the number of packets this key should be used to encode or decode before evolution takes place. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a3d957a51193dda882cb89ced2ceeb91e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d957a51193dda882cb89ced2ceeb91e">&#9670;&nbsp;</a></span>cipher_key</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">wickr_stream_key::cipher_key</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>key used to encrypt or decrypt packets when the key is used for cipher operations </p>

</div>
</div>
<a id="ae7210bd67e61cb4c38733a237dae95d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7210bd67e61cb4c38733a237dae95d9">&#9670;&nbsp;</a></span>evolution_key</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">wickr_stream_key::evolution_key</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>data to be used to help evolove the key when 'cipher_key' is used 'packets_per_evolution' times </p>

</div>
</div>
<a id="a78777e4c64048b6dae38f8772744194e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a78777e4c64048b6dae38f8772744194e">&#9670;&nbsp;</a></span>packets_per_evolution</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">wickr_stream_key::packets_per_evolution</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>number of packets this key should be used before it is evoloved using 'evolution_key' </p>

</div>
</div>
<a id="a51e59da9f7fbb0b3e1332a20252d1cc6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51e59da9f7fbb0b3e1332a20252d1cc6">&#9670;&nbsp;</a></span>user_data</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">wickr_stream_key::user_data</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>user provided data to assoiciate with the key </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/wickrcrypto/include/wickrcrypto/<a class="el" href="stream__key_8h_source.html">stream_key.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
